Skip to content
This repository was archived by the owner on Feb 22, 2018. It is now read-only.

Generate documentation from the lib directory instead of packages. #1024

Closed
wants to merge 1 commit into from

Conversation

efortuna
Copy link
Contributor

@efortuna efortuna commented May 8, 2014

fix(generate-documentation.sh): Generate documentation from the lib directory instead of packages.

Packages directory is going away eventually, and this removes the dart:core sidebar link as well.

@naomiblack
Copy link
Contributor

Sorry I was so slow to get to this! Although this removes the dart:core sidebar, it also removes the di library (lib/directive/module.dart). Any suggestions for including that? I'm not sure why this change makes it go away...

@efortuna
Copy link
Contributor Author

All of the members declared in the di are still there because they are re-exported by angular.dart. Seems like if you're importing angular, and they are re-exported, there's no need to also show the di library as separate.

@naomiblack
Copy link
Contributor

Ohh. So now Key (for example) which was ib #angular/di.key is now in #angular/angular.Key? I think that is ok. Can I get them to show up as part of library di.dart when I search for them in the top-right search box? Right now they show up as "class library angular in angular" instead of "class library di", which is confusing I think.

@vicb
Copy link
Contributor

vicb commented May 23, 2014

@naomiblack my understanding is that we want to use Key from angular (which is the reason why we re-export it). Then I think what you see is fine.

@naomiblack
Copy link
Contributor

I still think "class library angular in angular" (which you see in the search bar) seems wrong. Shouldn't it just be showing up as "class library in angular"?

@vicb
Copy link
Contributor

vicb commented May 23, 2014

Actually I understand neither of them, is there an example somewhere online ?

@naomiblack
Copy link
Contributor

I had to generate locally, but this isn't really any more confusing (just different) from the current docs, so I'll go ahead and accept this PR so you can see it. :)

@efortuna
Copy link
Contributor Author

@vicb -- understand neither of what?

@naomiblack -- The search results say:

"Key
class
library angular in angular"

This is to mean that the class Key, is a class in the library angular, in the angular package.

Small edit: the "class" should be right aligned with the text, but github is removing the whitespace for me.

@vicb
Copy link
Contributor

vicb commented May 23, 2014

Got it now... I prefer "angular:angular" but that's probably because I'm used to it

@efortuna
Copy link
Contributor Author

That can be tweaked, but would be a different CL (not in the angular codebase here)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Development

Successfully merging this pull request may close these issues.

3 participants